SaveAll(string,AnnContainer[],AnnFormat) Method

Summary

Saves an array of annotation containers to a file.

Syntax

Objective-C

C++

Java

public void SaveAll( 
   string fileName, 
   AnnContainer[] containers, 
   AnnFormat format 
)

Public Overloads Sub SaveAll( _ 
   ByVal fileName As String, _ 
   ByVal containers() As AnnContainer, _ 
   ByVal format As AnnFormat _ 
)

-(void) saveAll:(NSString*)fileName 
   container:(NSArray*)containers 
 savePageNumber:(int)savePageNumber;

public void saveAll(String fileName, AnnContainer[] containers, AnnFormat format);

public:  
   void SaveAll( 
      String^ fileName, 
      array<AnnContainer^>^ containers, 
      AnnFormat^ format 
   )

Parameters

fileName
Destination file name to save the data to.

containers
The array of AnnContainer to be saved. This value must not be null.

format
Must be AnnFormat.Annotations.

Remarks

This method will override any existing data in fileName if it is not a new file.

This method uses the values of AnnContainer.PageNumber during its operation. The page numbers will be saved along with each container.

The AnnContainer.PageNumber value of each container will be used to indicate the output page number. If more than one container has the same value for PageNumber, then only the last container is used. Any AnnContainer object that is null in the array will be ignored.

The SerializeOptions property can contain optional options and events to use during saving of annotations data.

For more information, refer to Annotation Files.

Requirements

Target Platforms

Reference

AnnCodecs Class

AnnCodecs Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies